Modify Dial Plan Content for SIP Connection
The Modify Dial Plan Content for SIP Connection request allows you to add or remove phone numbers in a specific dial plan for a specific SIP Connection (Site Location).
URL
{{baseUrl}}/api/v2/customer/{{customerId}}/sitelocation/{{siteLocationId}}/dialplan/{dialplanId}Method
PATCH
Request Parameters
|
Parameters |
Type |
Description |
|---|---|---|
|
customerId |
string($uuid) |
Unique customer 'Id' created when customer is added. Extract this value from Get Services Brief Details (V3) request. |
|
sitelocationId |
string($uuid) |
Unique Id for SIP Connection (Site Location). For services with a single site, this value is identical to Customer 'Id' above. To retrieve this value, see Get Site Location. |
|
dialplanId |
string |
The name of the dial plan. |
Request Body
|
Parameters |
Type |
Description |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
dialPlanId |
string |
Dial plan name. Default 'CustDialPlan'. |
|||||||||
|
add |
list array |
List array including the following parameters:
|
|||||||||
|
name |
string |
Name of the dial plan rule that is configured for the SIP Connection in the Onboarding script. |
|||||||||
|
prefix |
string |
The calling prefixes to add for users for this site location. For example "{{+019123854567}}" |
|||||||||
|
tag |
string |
The Derived Trunk FQDN of the SBC device used to manage calls for this site location. For example, "{{EMEA.Customers.AudioCodes.com}}". If a number is added with a tag that is not an AudioCodes SBC PSTN gateway, then for the purpose of User licensing calculations, its counted as a Service Number license factor. For more information, see User Licenses. |
Example Body (Add Prefixes)
{
"dialPlanId": "CustDialPlan",
"add": [
{
"name": "CustDialPlan",
"prefix": "+97239753000",
"tag": "sandbox1.audiocodes.be"
},
{
"name": "CustDialPlan",
"prefix": "+97239753001",
"tag": "sandbox1.audiocodes.be"
},
{
"name": "CustDialPlan",
"prefix": "+97239753002",
"tag": "sandbox1.audiocodes.be"
},
{
"name": "CustDialPlan",
"prefix": "+97239753003",
"tag": "sandbox1.audiocodes.be"
}
]
}
Example Body (Remove Prefixes)
{
"dialPlanId": "CustDialPlan",
"remove": [
{
"name": "CustDialPlan",
"prefix": "+97239753000",
"tag": "sandbox1.audiocodes.be"
}
]
}HTTP Responses
The initial response displays the Task Id.
|
Parameter |
Type |
Description |
|---|---|---|
|
Task Id |
string |
The queued task Id that is generated for this action. You must run the Task request to retrieve the status of the action. See Task Status. Note that the tsk string in the prefix is unique for this endpoint. |
{
"taskId": "tsk_1156",
"dialPlanName": "CustDialPlan",
"error": null
}The execution of the request may take a few minutes. The status will progress from 'In Progress' to 'Completed Success'.
{
"id": "tsk_1157",
"status": "Queued",
"details": [
null
],
"executionMessages": null,
"outputData": {}
}
{
"id": "tsk_1156",
"status": "CompletedSuccess",
"details": [
"Ok"
],
"executionMessages": null,
"outputData": {}
}HTTP Responses
| ■ | 200 OK |
|
Parameter |
Type |
Description |
|||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
taskId |
string |
The task Id. |
|||||||||
|
status |
string |
One of the following:
|
|||||||||
|
details |
string |
Additional information on the task. e.g. OK |
|||||||||
|
executionMessages |
string |
Additional information. |
|||||||||
|
outputData |
string |
Additional information. |